home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 27.zip / BS1 part 27 / ExcellenceV3.1_d1.adf / ARexx_ReadMe < prev    next >
Text File  |  1993-06-19  |  5KB  |  104 lines
  1.                               ARexx Notes
  2.  
  3.  
  4. There are several sample ARexx programs in an ARexx directory.
  5. Each of these programs is prefaced by text explaining what
  6. exactly the program does, and contains suggestions for
  7. modifying it for your own use. If you want to see some
  8. examples of how to use excellence!'s ARexx commands, be sure
  9. to check these files out.
  10.  
  11.  
  12. GetErrorText er#  This is a new command which, when passed an error
  13.                   code returned by an excellence! command, will
  14.                   return a text description of that error in Result.
  15.                   You can then immediately use Request1 to display
  16.                   the error message, or Vocalize to say the error
  17.                   message, etc. 
  18.  
  19. Extract [n]       Extract will also now accept an optional parameter
  20.                   n, which is the number of characters to extract. If
  21.                   no text is highlighted, then Extract n will extract
  22.                   n characters from the document from the right of the
  23.                   insertion point. If text is highlighted, then Extract
  24.                   n will extract the highlighted text up to a maximum
  25.                   of n characters. If the optional parameter n is not
  26.                   specified, then Extract will extract the first word
  27.                   to the right of the cursor if no text is highlighted,
  28.                   or all highlighted text if any text is highlighted.
  29.                   Extract will work across multiple paragraphs,
  30.                   preserving the ASCII return character at paragraph
  31.                   breaks. 
  32.  
  33. Type              You can use any reserved glossary keywords within the,
  34.                   text passed to Type. This allows you to control cursor
  35.                   movement by placing {left}{up}{ctrl}{down} etc.
  36.                   commands within the actual text passed to type. For
  37.                   example, to place the words 'top of file' at the top
  38.                   of a document, you could use:
  39.                   
  40.                   Type '{alt}{up}{ctrl}{left}Top of file{cr}'
  41.    
  42.                   You can even call menu options via Type, although it is
  43.                   easier to do this using the Menu command. You cannot call
  44.                   saved glossary entries with type. Instead reference
  45.                   them as if they were an ARexx command. For example,
  46.                   if you have a glossary macro which places you letterhead
  47.                   at the top of the document named {letterhead}, you can
  48.                   enterLetterhead as if it were an ARexx command. When
  49.                   excellence! receives the message Letterhead, after making
  50.                   sure it isn't an ARexx command, excellence! then checks
  51.                   the glossary to see if any glossary macros exist with
  52.                   that name, and if so, executes it.
  53.  
  54. RequestList       This command needs its list separated by commas,
  55.                   not spaces, so that it may display items containing
  56.                   spaces. This is particularly useful when working with
  57.                   lists supplied from the Thesaurus, as many "synonyms"
  58.                   contain spaces. If you wish to have it display items
  59.                   from a list of words separated by spaces, use the ARexx
  60.                   Space command to transform the spaces into commas.
  61.                   The commas are not displayed in the listbox nor are they
  62.                   returned when a user selects an item. The first argument
  63.                   is the information string. An example of using it with a
  64.                   list of words separated by spaces would be: RequestList
  65.                   'Select one item,'space(wordlist,1,',')  where wordlist
  66.                   is a list of words separated by spaces. The ThesSyn,
  67.                   ThesAnt, and SpellSuggest commands return lists separated
  68.                   by commas, so you can use the results of these functions
  69.                   without modification. Each item in a listbox can be no
  70.                   more than thirty characters long, beyond that additional
  71.                   text will be truncated. 
  72.  
  73. ThesSyn,
  74. ThesAnt,
  75. SpellSUggest      These functions return their lists in a comma-separated
  76.                   format, so they may be used immediately with RequestList.
  77.                   If you desire to change them to a space separated format,
  78.                   for easy use with ARexx's parsing and word functions,
  79.                   simply use the translate command. Example:
  80.  
  81.                   ThesSyn 'bright'
  82.                   list = translate(result,' ',',')
  83.                   n = words(list)
  84.                   x = subword(list,1,1)
  85.                   etc....
  86.  
  87.  
  88. Font              This command requires a font and size separated by a
  89.                   comma, therefore these parameters should be placed
  90.                   inside quotes, as in Font 'topaz,11'. Otherwise, ARexx
  91.                   will treat the comma as a continuation character, with
  92.                   all characters after the comma being treated as
  93.                   "extraneous characters."
  94.  
  95. SpellFind         Returns a word that was not found in the dictionary if one
  96.                   is found in Result. However, if no misspelled words are
  97.                   found, it does NOT set Result to Null, but instead sets
  98.                   RC to the appropriate error value. 
  99.  
  100.  
  101.    
  102.  
  103.    
  104.